<!DOCTYPE html>
<html lang="en">
<head>
<title>WebView4Delphi: uWVCoreWebView2Args: Class TCoreWebView2ScreenCaptureStartingEventArgs</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0-snapshot">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<span id="TCoreWebView2ScreenCaptureStartingEventArgs"></span><h1 class="cio">Class TCoreWebView2ScreenCaptureStartingEventArgs</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section"><a class="section" href="#PasDoc-Fields">Fields</a></div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="uWVCoreWebView2Args.html">uWVCoreWebView2Args</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCoreWebView2ScreenCaptureStartingEventArgs = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
 Event args for the `ScreenCaptureStarting` event. </p>
<p>


<p>&lt;see href=&quot;<a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/tcorewebview2screencapturestartingeventargs">https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/tcorewebview2screencapturestartingeventargs</a>&quot;&gt;See the TCoreWebView2ScreenCaptureStartingEventArgs article.)</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TCoreWebView2ScreenCaptureStartingEventArgs</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Fields"></span><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#FBaseIntf">FBaseIntf</a></strong>: <a href="uWVTypeLibrary.ICoreWebView2ScreenCaptureStartingEventArgs.html">ICoreWebView2ScreenCaptureStartingEventArgs</a>;</code></td>
</tr>
</table>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetInitialized">GetInitialized</a></strong>: boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetCancel">GetCancel</a></strong>: boolean;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetHandled">GetHandled</a></strong>: boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetCoreWebView2FrameInfo">GetCoreWebView2FrameInfo</a></strong>: <a href="uWVTypeLibrary.ICoreWebView2FrameInfo.html">ICoreWebView2FrameInfo</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetDeferral">GetDeferral</a></strong>: <a href="uWVTypeLibrary.ICoreWebView2Deferral.html">ICoreWebView2Deferral</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#SetCancel-boolean-">SetCancel</a></strong>(aValue: boolean);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#SetHandled-boolean-">SetHandled</a></strong>(aValue: boolean);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#Create-ICoreWebView2ScreenCaptureStartingEventArgs-">Create</a></strong>(const aArgs: <a href="uWVTypeLibrary.ICoreWebView2ScreenCaptureStartingEventArgs.html">ICoreWebView2ScreenCaptureStartingEventArgs</a>); reintroduce;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#Destroy">Destroy</a></strong>; override;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#Initialized">Initialized</a></strong>                   : boolean                                           read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetInitialized">GetInitialized</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#BaseIntf">BaseIntf</a></strong>                      : <a href="uWVTypeLibrary.ICoreWebView2ScreenCaptureStartingEventArgs.html">ICoreWebView2ScreenCaptureStartingEventArgs</a>       read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#FBaseIntf">FBaseIntf</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#Cancel">Cancel</a></strong>                        : boolean                                           read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetCancel">GetCancel</a>                  write <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#SetCancel-boolean-">SetCancel</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#Handled">Handled</a></strong>                       : boolean                                           read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetHandled">GetHandled</a>                 write <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#SetHandled-boolean-">SetHandled</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#OriginalSourceFrameInfo">OriginalSourceFrameInfo</a></strong>       : <a href="uWVTypeLibrary.ICoreWebView2FrameInfo.html">ICoreWebView2FrameInfo</a>                            read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetCoreWebView2FrameInfo">GetCoreWebView2FrameInfo</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#Deferral">Deferral</a></strong>                      : <a href="uWVTypeLibrary.ICoreWebView2Deferral.html">ICoreWebView2Deferral</a>                             read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetDeferral">GetDeferral</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="FBaseIntf"></span><code><strong>FBaseIntf</strong>: <a href="uWVTypeLibrary.ICoreWebView2ScreenCaptureStartingEventArgs.html">ICoreWebView2ScreenCaptureStartingEventArgs</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetInitialized"></span><code>function <strong>GetInitialized</strong>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetCancel"></span><code>function <strong>GetCancel</strong>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetHandled"></span><code>function <strong>GetHandled</strong>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetCoreWebView2FrameInfo"></span><code>function <strong>GetCoreWebView2FrameInfo</strong>: <a href="uWVTypeLibrary.ICoreWebView2FrameInfo.html">ICoreWebView2FrameInfo</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetDeferral"></span><code>function <strong>GetDeferral</strong>: <a href="uWVTypeLibrary.ICoreWebView2Deferral.html">ICoreWebView2Deferral</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="SetCancel-boolean-"></span><code>procedure <strong>SetCancel</strong>(aValue: boolean);</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="SetHandled-boolean-"></span><code>procedure <strong>SetHandled</strong>(aValue: boolean);</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create-ICoreWebView2ScreenCaptureStartingEventArgs-"></span><code>constructor <strong>Create</strong>(const aArgs: <a href="uWVTypeLibrary.ICoreWebView2ScreenCaptureStartingEventArgs.html">ICoreWebView2ScreenCaptureStartingEventArgs</a>); reintroduce;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Destroy"></span><code>destructor <strong>Destroy</strong>; override;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Initialized"></span><code>property <strong>Initialized</strong>                   : boolean                                           read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetInitialized">GetInitialized</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
 Returns true when the interface implemented by this class is fully initialized. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="BaseIntf"></span><code>property <strong>BaseIntf</strong>                      : <a href="uWVTypeLibrary.ICoreWebView2ScreenCaptureStartingEventArgs.html">ICoreWebView2ScreenCaptureStartingEventArgs</a>       read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#FBaseIntf">FBaseIntf</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
 Returns the interface implemented by this class. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Cancel"></span><code>property <strong>Cancel</strong>                        : boolean                                           read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetCancel">GetCancel</a>                  write <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#SetCancel-boolean-">SetCancel</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>


<p>The host may set this flag to cancel the screen capture. If canceled, the screen capture UI is not displayed regardless of the `Handled` property.

<p>On the script side, it will return with a NotAllowedError as Permission denied.

<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Handled"></span><code>property <strong>Handled</strong>                       : boolean                                           read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetHandled">GetHandled</a>                 write <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#SetHandled-boolean-">SetHandled</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>


<p>By default, both the `ScreenCaptureStarting` event handlers on the `CoreWebView2Frame` and the `CoreWebView2` will be invoked, with the `CoreWebView2Frame` event handlers invoked first. The host may set this flag to `TRUE` within the `CoreWebView2Frame` event handlers to prevent the remaining `CoreWebView2` event handlers from being invoked. If the flag is set to `FALSE` within the `CoreWebView2Frame` event handlers, downstream handlers can update the `Cancel` property.

<p>If a deferral is taken on the event args, then you must synchronously set `Handled` to TRUE prior to taking your deferral to prevent the `CoreWebView2`s event handlers from being invoked.

<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="OriginalSourceFrameInfo"></span><code>property <strong>OriginalSourceFrameInfo</strong>       : <a href="uWVTypeLibrary.ICoreWebView2FrameInfo.html">ICoreWebView2FrameInfo</a>                            read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetCoreWebView2FrameInfo">GetCoreWebView2FrameInfo</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
 The associated frame information that requests the screen capture permission. This can be used to get the frame source, name, frameId, and parent frame information. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Deferral"></span><code>property <strong>Deferral</strong>                      : <a href="uWVTypeLibrary.ICoreWebView2Deferral.html">ICoreWebView2Deferral</a>                             read <a href="uWVCoreWebView2Args.TCoreWebView2ScreenCaptureStartingEventArgs.html#GetDeferral">GetDeferral</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
 Returns an `ICoreWebView2Deferral` object. Use this deferral to defer the decision to show the Screen Capture UI. getDisplayMedia() won't call its callbacks until the deferral is completed. </p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0-snapshot</a>. </em>
</span>
</body></html>
